Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify code block that is not run and break out nano steps #1061

Merged
merged 2 commits into from
Jan 25, 2025

Conversation

erinmgraham
Copy link
Contributor

Closes #891

Code blocks with 'bash' that are not can be confusing and this lesson often uses nano and cat in the same code block without the bit in the middle. It is definitely more time consuming to separate but I think also easier for beginners to follow.

Copy link

github-actions bot commented Jan 10, 2025

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1061

The following changes were observed in the rendered markdown documents:

 04-changes.md |  8 +-------
 06-ignore.md  | 14 ++++++++++++++
 md5sum.txt    |  4 ++--
 3 files changed, 17 insertions(+), 9 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-01-21 01:52:12 +0000

github-actions bot pushed a commit that referenced this pull request Jan 10, 2025
@martinosorb
Copy link
Contributor

I totally agree on the changes to 06-ignore, that's a clear improvement, thanks.

Regarding the change to 04-changes, why do you say that that's not bash? Is it because of the <directory-with-files> placeholder? If you think that's confusing, we could just change the whole thing to "you can add all files in the directory at once by using git add", because there's an example immediately after anyway. In fact, I think we should. What do you think?

github-actions bot pushed a commit that referenced this pull request Jan 21, 2025
@erinmgraham
Copy link
Contributor Author

Haha, I agree! I did consider it at the time but trying to be mindful of previous maintainer's decisions.

@martinosorb martinosorb merged commit 7fcdf4c into swcarpentry:main Jan 25, 2025
3 checks passed
@martinosorb
Copy link
Contributor

Thanks!

github-actions bot pushed a commit that referenced this pull request Jan 25, 2025
Auto-generated via `{sandpaper}`
Source  : 7fcdf4c
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2025-01-25 16:35:23 +0000
Message : Merge pull request #1061 from erinmgraham/issue-891

clarify code block that is not run and break out nano steps
github-actions bot pushed a commit that referenced this pull request Jan 25, 2025
Auto-generated via `{sandpaper}`
Source  : f778687
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2025-01-25 16:36:27 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : 7fcdf4c
Branch  : main
Author  : Martino Sorbaro <[email protected]>
Time    : 2025-01-25 16:35:23 +0000
Message : Merge pull request #1061 from erinmgraham/issue-891

clarify code block that is not run and break out nano steps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recommended comments to clarify sections
2 participants